<!DOCTYPE html>
<html lang="en">
<head>
	<meta charset="UTF-8">
	<meta http-equiv="X-UA-Compatible" content="IE=edge">
    <meta name="viewport" content="width=device-width, initial-scale=1">
	<title>Enrich stats API | ElasticSearch 7.7 权威指南中文版</title>
	<meta name="keywords" content="ElasticSearch 权威指南中文版, elasticsearch 7, es7, 实时数据分析，实时数据检索" />
    <meta name="description" content="ElasticSearch 权威指南中文版, elasticsearch 7, es7, 实时数据分析，实时数据检索" />
    <!-- Give IE8 a fighting chance -->
    <!--[if lt IE 9]>
    <script src="https://oss.maxcdn.com/html5shiv/3.7.2/html5shiv.min.js"></script>
    <script src="https://oss.maxcdn.com/respond/1.4.2/respond.min.js"></script>
    <![endif]-->
	<link rel="stylesheet" type="text/css" href="../static/styles.css" />
	<script>
	var _link = 'enrich-stats-api.html';
    </script>
</head>
<body>
<div class="main-container">
    <section id="content">
        <div class="content-wrapper">
            <section id="guide" lang="zh_cn">
                <div class="container">
                    <div class="row">
                        <div class="col-xs-12 col-sm-8 col-md-8 guide-section">
                            <div style="color:gray; word-break: break-all; font-size:12px;">原英文版地址: <a href="https://www.elastic.co/guide/en/elasticsearch/reference/7.7/enrich-stats-api.html" rel="nofollow" target="_blank">https://www.elastic.co/guide/en/elasticsearch/reference/7.7/enrich-stats-api.html</a>, 原文档版权归 www.elastic.co 所有<br/>本地英文版地址: <a href="../en/enrich-stats-api.html" rel="nofollow" target="_blank">../en/enrich-stats-api.html</a></div>
                        <!-- start body -->
                  <div class="page_header">
<strong>重要</strong>: 此版本不会发布额外的bug修复或文档更新。最新信息请参考 <a href="https://www.elastic.co/guide/en/elasticsearch/reference/current/index.html" rel="nofollow">当前版本文档</a>。
</div>
<div id="content">
<div class="breadcrumbs">
<span class="breadcrumb-link"><a href="index.html">Elasticsearch Guide [7.7]</a></span>
»
<span class="breadcrumb-link"><a href="rest-apis.html">REST APIs</a></span>
»
<span class="breadcrumb-link"><a href="enrich-apis.html">Enrich APIs</a></span>
»
<span class="breadcrumb-node">Enrich stats API</span>
</div>
<div class="navheader">
<span class="prev">
<a href="execute-enrich-policy-api.html">« Execute enrich policy API</a>
</span>
<span class="next">
<a href="graph-explore-api.html">Explore API »</a>
</span>
</div>
<div class="section xpack">
<div class="titlepage"><div><div>
<h2 class="title">
<a id="enrich-stats-api"></a>Enrich stats API<a class="edit_me edit_me_private" rel="nofollow" title="Editing on GitHub is available to Elastic" href="https://github.com/elastic/elasticsearch/edit/7.7/docs/reference/ingest/apis/enrich/enrich-stats.asciidoc">edit</a><a class="xpack_tag" href="https://www.elastic.co/subscriptions"></a>
</h2>
</div></div></div>

<p>Returns <a class="xref" href="modules-node.html#coordinating-node" title="Coordinating node">enrich coordinator</a> statistics
and information about <a class="xref" href="ingest-enriching-data.html#enrich-policy">enrich policies</a>
that are currently executing.</p>
<div class="pre_wrapper lang-console">
<pre class="programlisting prettyprint lang-console">GET /_enrich/_stats</pre>
</div>
<div class="console_widget" data-snippet="snippets/1585.console"></div>
<div class="section">
<div class="titlepage"><div><div>
<h3 class="title">
<a id="enrich-stats-api-request"></a>Request<a class="edit_me edit_me_private" rel="nofollow" title="Editing on GitHub is available to Elastic" href="https://github.com/elastic/elasticsearch/edit/7.7/docs/reference/ingest/apis/enrich/enrich-stats.asciidoc">edit</a>
</h3>
</div></div></div>
<p><code class="literal">GET /_enrich/_stats</code></p>
</div>

<div class="section">
<div class="titlepage"><div><div>
<h3 class="title">
<a id="enrich-stats-api-response-body"></a>Response body<a class="edit_me edit_me_private" rel="nofollow" title="Editing on GitHub is available to Elastic" href="https://github.com/elastic/elasticsearch/edit/7.7/docs/reference/ingest/apis/enrich/enrich-stats.asciidoc">edit</a>
</h3>
</div></div></div>
<div class="variablelist">
<dl class="variablelist">
<dt>
<span class="term">
<code class="literal">executing_policies</code>
</span>
</dt>
<dd>
<p>(Array of objects)
Objects containing information
about each enrich policy
that is currently executing.</p>
<p>Returned parameters include:</p>
<div class="variablelist">
<dl class="variablelist">
<dt>
<span class="term">
<code class="literal">name</code>
</span>
</dt>
<dd>
(String)
Name of the enrich policy.
</dd>
<dt>
<span class="term">
<code class="literal">task</code>
</span>
</dt>
<dd>
(<a class="xref" href="tasks.html" title="Task management API">Task object</a>)
Object containing detailed information
about the policy execution task.
</dd>
</dl>
</div>
</dd>
<dt>
<span class="term">
<code class="literal">coordinator_stats</code>
</span>
</dt>
<dd>
<p>(Array of objects)
Objects containing information
about each <a class="xref" href="modules-node.html#coordinating-node" title="Coordinating node">coordinating ingest node</a>
for configured enrich processors.</p>
<p>Returned parameters include:</p>
<div class="variablelist">
<dl class="variablelist">
<dt>
<span class="term">
<code class="literal">node_id</code>
</span>
</dt>
<dd>
(String)
ID of the ingest node coordinating search requests
for configured enrich processors.
</dd>
<dt>
<span class="term">
<code class="literal">queue_size</code>
</span>
</dt>
<dd>
(Integer)
Number of search requests in the queue.
</dd>
<dt>
<span class="term">
<code class="literal">remote_requests_current</code>
</span>
</dt>
<dd>
(Integer)
Current number of outstanding remote requests.
</dd>
<dt>
<span class="term">
<code class="literal">remote_requests_total</code>
</span>
</dt>
<dd>
<p>
(Integer)
Number of outstanding remote requests executed
since node startup.
</p>
<p>In most cases,
a remote request includes multiple search requests.
This depends on the number of search requests in the queue
when the remote request is executed.</p>
</dd>
<dt>
<span class="term">
<code class="literal">executed_searches_total</code>
</span>
</dt>
<dd>
(Integer)
Number of search requests
that enrich processors have executed
since node startup.
</dd>
</dl>
</div>
</dd>
</dl>
</div>
</div>

<div class="section">
<div class="titlepage"><div><div>
<h3 class="title">
<a id="enrich-stats-api-example"></a>Examples<a class="edit_me edit_me_private" rel="nofollow" title="Editing on GitHub is available to Elastic" href="https://github.com/elastic/elasticsearch/edit/7.7/docs/reference/ingest/apis/enrich/enrich-stats.asciidoc">edit</a>
</h3>
</div></div></div>
<div class="pre_wrapper lang-console">
<pre class="programlisting prettyprint lang-console">GET /_enrich/_stats</pre>
</div>
<div class="console_widget" data-snippet="snippets/1586.console"></div>
<p>The API returns the following response:</p>
<div class="pre_wrapper lang-console-result">
<pre class="programlisting prettyprint lang-console-result">{
    "executing_policies": [
        {
            "name": "my-policy",
            "task": {
                "id" : 124,
                "type" : "direct",
                "action" : "cluster:admin/xpack/enrich/execute",
                "start_time_in_millis" : 1458585884904,
                "running_time_in_nanos" : 47402,
                "cancellable" : false,
                "parent_task_id" : "oTUltX4IQMOUUVeiohTt8A:123",
                "headers" : {
                    "X-Opaque-Id" : "123456"
                }
            }
        }
    ],
    "coordinator_stats": [
        {
            "node_id": "1sFM8cmSROZYhPxVsiWew",
            "queue_size": 0,
            "remote_requests_current": 0,
            "remote_requests_total": 0,
            "executed_searches_total": 0
        }
    ]
}</pre>
</div>
</div>

</div>
<div class="navfooter">
<span class="prev">
<a href="execute-enrich-policy-api.html">« Execute enrich policy API</a>
</span>
<span class="next">
<a href="graph-explore-api.html">Explore API »</a>
</span>
</div>
</div>

                  <!-- end body -->
                        </div>
                        <div class="col-xs-12 col-sm-4 col-md-4" id="right_col">
                        
                        </div>
                    </div>
                </div>
            </section>
        </div>
    </section>
</div>
<script src="../static/cn.js"></script>
</body>
</html>